Add more documentation#1123
Merged
adamhathcock merged 5 commits intomasterfrom Jan 11, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request restructures documentation by moving usage documentation into the docs directory and adding comprehensive new documentation files. The changes primarily focus on improving documentation organization and adding extensive guides for performance, encoding, architecture, and API usage.
- Moved USAGE.md to docs/USAGE.md and updated all internal references
- Added six new comprehensive documentation files (PERFORMANCE.md, FORMATS.md, ENCODING.md, ARCHITECTURE.md, API.md, OLD_CHANGELOG.md)
- Updated links in README.md and AGENTS.md to point to the new documentation locations
- Added "Beta" label to async/await section and simplified "Stream Rules" title
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/USAGE.md | Labeled async/await support as "Beta" and simplified Stream Rules section title |
| docs/PERFORMANCE.md | New comprehensive performance optimization guide with API selection, buffering, and troubleshooting advice |
| docs/OLD_CHANGELOG.md | New file containing historical version logs from 0.10 through 0.18 |
| docs/FORMATS.md | New file documenting supported archive formats, compression methods, and format-specific notes |
| docs/ENCODING.md | New extensive guide on character encoding handling for international filenames |
| docs/ARCHITECTURE.md | New detailed architecture documentation for contributors including design patterns and internal structure |
| docs/API.md | New quick reference guide for commonly used SharpCompress APIs with code examples |
| README.md | Updated documentation links to point to docs/USAGE.md and docs/FORMATS.md |
| AGENTS.md | Updated FORMATS.md reference to docs/FORMATS.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Related Documentation | ||
|
|
||
| - [PERFORMANCE.md](USAGE.md) - Usage examples with performance considerations |
There was a problem hiding this comment.
The link to "PERFORMANCE.md" should be "USAGE.md" since this line appears in PERFORMANCE.md and is trying to reference USAGE.md for usage examples.
Suggested change
| - [PERFORMANCE.md](USAGE.md) - Usage examples with performance considerations | |
| - [USAGE.md](USAGE.md) - Usage examples with performance considerations |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 9 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove CONTRIBUTING.md reference from ARCHITECTURE.md - Remove ERRORS.md reference from API.md - Remove TROUBLESHOOTING.md reference from ENCODING.md - Remove TROUBLESHOOTING.md reference from PERFORMANCE.md All markdown files now reference only existing documentation.
Agents should stage files and leave committing to the user. Only create commits when the user explicitly requests them.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 9 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
adamhathcock
commented
Jan 8, 2026
| ### Object Pooling for Repeated Operations | ||
|
|
||
| ```csharp | ||
| // For very high-throughput scenarios, consider pooling |
|
|
||
| ## Memory Efficiency | ||
|
|
||
| ### Reducing Allocations |
| | Download streams | Reader | Async extraction while downloading | | ||
|
|
||
| ### 2. Batch Operations | ||
|
|
| } | ||
| ``` | ||
|
|
||
| ### 3. Use Appropriate Compression |
|
|
||
| ## Buffer Sizing | ||
|
|
||
| ### Understanding Buffers |
|
|
||
| ## Compression Level Trade-offs | ||
|
|
||
| ### Deflate/GZip Levels |
This was referenced Feb 11, 2026
Closed
This was referenced Feb 23, 2026
This was referenced Mar 2, 2026
Closed
This was referenced Mar 9, 2026
Closed
This was referenced Mar 23, 2026
This was referenced Mar 30, 2026
This was referenced Apr 6, 2026
This was referenced Apr 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request primarily updates documentation to improve clarity and maintain consistency after moving usage documentation into the
docsdirectory. It also adds an important guideline for agents and updates links to reflect the new documentation structure.Documentation structure and link updates:
USAGE.mdandFORMATS.mdinREADME.mdandAGENTS.mdto point to their new locations under thedocs/directory. [1] [2] [3]USAGE.mdtodocs/USAGE.mdand updated its headings for clarity, including marking async/await support as "Beta" and simplifying the "Stream Rules" section heading. [1] [2]Agent guidelines:
AGENTS.mdstating that agents should never commit to git, but only stage files, leaving commits to the user unless explicitly requested.